Make it easier to include modules into backend class #538

shioyama · 2021-10-17T12:48:17Z

This is a simple change which allows plugins to simply define modules BackendMethods and/or BackendClassMethods and have the backend class auto-include/extend these modules. This simplifies something like this:

module MyPlugin
  extend Mobility::Plugin

  included_hook do |klass, backend_class|
    backend_class.include BackendMethods
    backend_class.extend BackendClassMethods
  end

  module BackendMethods
    # ...
  end

  module BackendClassMethods
    # ...
  end
end

To just this:

module MyPlugin
  extend Mobility::Plugin

  module BackendMethods
    # ...
  end

  module BackendClassMethods
    # ...
  end
end

With this change, if no included hook is defined on a plugin *and* the plugin defines module(s) named BackendMethods (instance methods) and/or BackendClassMethods (class methods), a hook is auto-defined to include/extend those modules from the backend class.

This was referenced Oct 17, 2021

WIP: Allow to pass a proc as fallback for conditional fallbacks #328

Closed

Set fallbacks per request? #405

Closed

shioyama added 4 commits November 3, 2021 17:52

Delete unused constant alias

21c5cbf

BackendInstanceMethods -> BackendMethods

7ceeff7

Add some inline docs about BackendMethods module auto-inclusion

dc2aedd

shioyama force-pushed the backend_methods_included_hook branch from a7bb8c2 to dc2aedd Compare November 3, 2021 08:53

Update changelog

6c4b96b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make it easier to include modules into backend class #538

Make it easier to include modules into backend class #538

shioyama commented Oct 17, 2021

Make it easier to include modules into backend class #538

Are you sure you want to change the base?

Make it easier to include modules into backend class #538

Conversation

shioyama commented Oct 17, 2021